summaryrefslogtreecommitdiffstats
path: root/src/android/app/src/main/java/org/yuzu/yuzu_emu/adapters/GameAdapter.java
blob: fa785741b7fbfbe58df0d154463fc5a7953f6a10 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
package org.yuzu.yuzu_emu.adapters;

import android.database.Cursor;
import android.database.DataSetObserver;
import android.graphics.Rect;
import android.graphics.drawable.Drawable;
import android.os.Build;
import android.os.SystemClock;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;

import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;
import androidx.core.content.ContextCompat;
import androidx.fragment.app.FragmentActivity;
import androidx.recyclerview.widget.RecyclerView;

import org.yuzu.yuzu_emu.R;
import org.yuzu.yuzu_emu.activities.EmulationActivity;
import org.yuzu.yuzu_emu.model.GameDatabase;
import org.yuzu.yuzu_emu.ui.DividerItemDecoration;
import org.yuzu.yuzu_emu.utils.Log;
import org.yuzu.yuzu_emu.utils.PicassoUtils;
import org.yuzu.yuzu_emu.viewholders.GameViewHolder;

import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.stream.Stream;

/**
 * This adapter gets its information from a database Cursor. This fact, paired with the usage of
 * ContentProviders and Loaders, allows for efficient display of a limited view into a (possibly)
 * large dataset.
 */
public final class GameAdapter extends RecyclerView.Adapter<GameViewHolder> implements
        View.OnClickListener {
    private Cursor mCursor;
    private GameDataSetObserver mObserver;

    private boolean mDatasetValid;
    private long mLastClickTime = 0;

    /**
     * Initializes the adapter's observer, which watches for changes to the dataset. The adapter will
     * display no data until a Cursor is supplied by a CursorLoader.
     */
    public GameAdapter() {
        mDatasetValid = false;
        mObserver = new GameDataSetObserver();
    }

    /**
     * Called by the LayoutManager when it is necessary to create a new view.
     *
     * @param parent   The RecyclerView (I think?) the created view will be thrown into.
     * @param viewType Not used here, but useful when more than one type of child will be used in the RecyclerView.
     * @return The created ViewHolder with references to all the child view's members.
     */
    @Override
    public GameViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        // Create a new view.
        View gameCard = LayoutInflater.from(parent.getContext())
                .inflate(R.layout.card_game, parent, false);

        gameCard.setOnClickListener(this);

        // Use that view to create a ViewHolder.
        return new GameViewHolder(gameCard);
    }

    /**
     * Called by the LayoutManager when a new view is not necessary because we can recycle
     * an existing one (for example, if a view just scrolled onto the screen from the bottom, we
     * can use the view that just scrolled off the top instead of inflating a new one.)
     *
     * @param holder   A ViewHolder representing the view we're recycling.
     * @param position The position of the 'new' view in the dataset.
     */
    @RequiresApi(api = Build.VERSION_CODES.O)
    @Override
    public void onBindViewHolder(@NonNull GameViewHolder holder, int position) {
        if (mDatasetValid) {
            if (mCursor.moveToPosition(position)) {
                PicassoUtils.loadGameIcon(holder.imageIcon,
                        mCursor.getString(GameDatabase.GAME_COLUMN_PATH));

                holder.textGameTitle.setText(mCursor.getString(GameDatabase.GAME_COLUMN_TITLE).replaceAll("[\\t\\n\\r]+", " "));
                holder.textCompany.setText(mCursor.getString(GameDatabase.GAME_COLUMN_COMPANY));

                final Path gamePath = Paths.get(mCursor.getString(GameDatabase.GAME_COLUMN_PATH));
                holder.textFileName.setText(gamePath.getFileName().toString());

                // TODO These shouldn't be necessary once the move to a DB-based model is complete.
                holder.gameId = mCursor.getString(GameDatabase.GAME_COLUMN_GAME_ID);
                holder.path = mCursor.getString(GameDatabase.GAME_COLUMN_PATH);
                holder.title = mCursor.getString(GameDatabase.GAME_COLUMN_TITLE);
                holder.description = mCursor.getString(GameDatabase.GAME_COLUMN_DESCRIPTION);
                holder.regions = mCursor.getString(GameDatabase.GAME_COLUMN_REGIONS);
                holder.company = mCursor.getString(GameDatabase.GAME_COLUMN_COMPANY);

                final int backgroundColorId = isValidGame(holder.path) ? R.color.view_background : R.color.view_disabled;
                View itemView = holder.getItemView();
                itemView.setBackgroundColor(ContextCompat.getColor(itemView.getContext(), backgroundColorId));
            } else {
                Log.error("[GameAdapter] Can't bind view; Cursor is not valid.");
            }
        } else {
            Log.error("[GameAdapter] Can't bind view; dataset is not valid.");
        }
    }

    /**
     * Called by the LayoutManager to find out how much data we have.
     *
     * @return Size of the dataset.
     */
    @Override
    public int getItemCount() {
        if (mDatasetValid && mCursor != null) {
            return mCursor.getCount();
        }
        Log.error("[GameAdapter] Dataset is not valid.");
        return 0;
    }

    /**
     * Return the contents of the _id column for a given row.
     *
     * @param position The row for which Android wants an ID.
     * @return A valid ID from the database, or 0 if not available.
     */
    @Override
    public long getItemId(int position) {
        if (mDatasetValid && mCursor != null) {
            if (mCursor.moveToPosition(position)) {
                return mCursor.getLong(GameDatabase.COLUMN_DB_ID);
            }
        }

        Log.error("[GameAdapter] Dataset is not valid.");
        return 0;
    }

    /**
     * Tell Android whether or not each item in the dataset has a stable identifier.
     * Which it does, because it's a database, so always tell Android 'true'.
     *
     * @param hasStableIds ignored.
     */
    @Override
    public void setHasStableIds(boolean hasStableIds) {
        super.setHasStableIds(true);
    }

    /**
     * When a load is finished, call this to replace the existing data with the newly-loaded
     * data.
     *
     * @param cursor The newly-loaded Cursor.
     */
    public void swapCursor(Cursor cursor) {
        // Sanity check.
        if (cursor == mCursor) {
            return;
        }

        // Before getting rid of the old cursor, disassociate it from the Observer.
        final Cursor oldCursor = mCursor;
        if (oldCursor != null && mObserver != null) {
            oldCursor.unregisterDataSetObserver(mObserver);
        }

        mCursor = cursor;
        if (mCursor != null) {
            // Attempt to associate the new Cursor with the Observer.
            if (mObserver != null) {
                mCursor.registerDataSetObserver(mObserver);
            }

            mDatasetValid = true;
        } else {
            mDatasetValid = false;
        }

        notifyDataSetChanged();
    }

    /**
     * Launches the game that was clicked on.
     *
     * @param view The card representing the game the user wants to play.
     */
    @Override
    public void onClick(View view) {
        // Double-click prevention, using threshold of 1000 ms
        if (SystemClock.elapsedRealtime() - mLastClickTime < 1000) {
            return;
        }
        mLastClickTime = SystemClock.elapsedRealtime();

        GameViewHolder holder = (GameViewHolder) view.getTag();

        EmulationActivity.launch((FragmentActivity) view.getContext(), holder.path, holder.title);
    }

    public static class SpacesItemDecoration extends DividerItemDecoration {
        private int space;

        public SpacesItemDecoration(Drawable divider, int space) {
            super(divider);
            this.space = space;
        }

        @Override
        public void getItemOffsets(Rect outRect, @NonNull View view, @NonNull RecyclerView parent,
                                   @NonNull RecyclerView.State state) {
            outRect.left = 0;
            outRect.right = 0;
            outRect.bottom = space;
            outRect.top = 0;
        }
    }

    private boolean isValidGame(String path) {
        return Stream.of(
                ".rar", ".zip", ".7z", ".torrent", ".tar", ".gz").noneMatch(suffix -> path.toLowerCase().endsWith(suffix));
    }

    private final class GameDataSetObserver extends DataSetObserver {
        @Override
        public void onChanged() {
            super.onChanged();

            mDatasetValid = true;
            notifyDataSetChanged();
        }

        @Override
        public void onInvalidated() {
            super.onInvalidated();

            mDatasetValid = false;
            notifyDataSetChanged();
        }
    }
}